Skip to content

docs: Update legacy auth migration guide to 4.0#604

Open
Zfinix wants to merge 1 commit into
mainfrom
chore/update-legacy-auth-guide-to-4
Open

docs: Update legacy auth migration guide to 4.0#604
Zfinix wants to merge 1 commit into
mainfrom
chore/update-legacy-auth-guide-to-4

Conversation

@Zfinix

@Zfinix Zfinix commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

Summary

Updates the legacy auth migration guide from 3.5 to 4.0: version pins, prose, and the link text to the upgrade guide. The page title (Migrate from legacy serverpod_auth), the 3.4 from-version, and the SDK constraints are unchanged. The link path to the upgrade guide is kept so it keeps resolving.

Note: the "Before you start" list still says the auth packages are "still beta" while pinning 4.0.0. If the auth stack ships stable with 4.0, that caveat should be trimmed; if it stays beta, the pins should be the beta version. Happy to adjust either way.

Part of #584

@Swiftaxe Swiftaxe left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Inconsistency in versioning. See comments.

@@ -1,19 +1,19 @@
---
description: Move a Serverpod 3.5 project off serverpod_auth_server onto the modular auth stack with email, Google, and Flutter session continuity.
description: Move a Serverpod 4.0 project off serverpod_auth_server onto the modular auth stack with email, Google, and Flutter session continuity.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: May be out of scope of this PR, but I just noticed this description can be improved to make it easier to understand. Something like: "Upgrade from serverpod_auth_server to the latest auth module..."

# Migrate from legacy serverpod_auth

This guide is for apps still running `serverpod_auth_server` on Serverpod 3.4 or earlier 3.5 betas. At the end, existing users sign in through the new modular auth stack with their old passwords and old sessions, and your legacy endpoints keep working until every client has rolled forward. Plan for about an hour, plus migration runtime.
This guide is for apps still running `serverpod_auth_server` on Serverpod 3.4 or earlier 4.0 betas. At the end, existing users sign in through the new modular auth stack with their old passwords and old sessions, and your legacy endpoints keep working until every client has rolled forward. Plan for about an hour, plus migration runtime.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

3.4 or earlier... sounds like <=3.4.

Suggested change
This guide is for apps still running `serverpod_auth_server` on Serverpod 3.4 or earlier 4.0 betas. At the end, existing users sign in through the new modular auth stack with their old passwords and old sessions, and your legacy endpoints keep working until every client has rolled forward. Plan for about an hour, plus migration runtime.
This guide is for apps still running `serverpod_auth_server` on Serverpod 3.4 or later. At the end, existing users sign in through the new modular auth stack with their old passwords and old sessions, and your legacy endpoints keep working until every client has rolled forward. Plan for about an hour, plus migration runtime.

@@ -1,19 +1,19 @@
---
description: Move a Serverpod 3.5 project off serverpod_auth_server onto the modular auth stack with email, Google, and Flutter session continuity.
description: Move a Serverpod 4.0 project off serverpod_auth_server onto the modular auth stack with email, Google, and Flutter session continuity.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The 4.0 reference here is not in line with what the actual guide states below: it is for users running 3.4 or 4.0 betas.

## Before you start

- A Serverpod 3.5.x project. If you are still on 3.4 or earlier, follow [Upgrade to 3.5](./upgrade-to-three-five) first.
- A Serverpod 4.0.x project. If you are still on 3.4 or earlier, follow [Upgrade to 4.0](./upgrade-to-three-five) first.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not in line with what is stated above. It is a bit ambigous, but I interpret it as meaning 3.4 and later.

- Flutter SDK 3.32.0 or later (only if you are migrating the Flutter app).
- Postgres 14 or later, or SQLite3.
- The four auth packages at `3.5.0-beta.9` (or the matching beta on pub.dev): `serverpod_auth_core`, `serverpod_auth_idp`, `serverpod_auth_bridge`, and `serverpod_auth_migration`. These are still beta and may receive breaking changes before 3.5 stable.
- The four auth packages at `4.0.0` (or the matching beta on pub.dev): `serverpod_auth_core`, `serverpod_auth_idp`, `serverpod_auth_bridge`, and `serverpod_auth_migration`. These are still beta and may receive breaking changes before 4.0 stable.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove references to beta versions etc, and make it 4.0.0 ready.

## Before you start

- A Serverpod 3.5.x project. If you are still on 3.4 or earlier, follow [Upgrade to 3.5](./upgrade-to-three-five) first.
- A Serverpod 4.0.x project. If you are still on 3.4 or earlier, follow [Upgrade to 4.0](./upgrade-to-three-five) first.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If upgrading to 4.0 is a requirement, this is based upon the migration to 4.0 PR #603 , and should thus be rebased upon that branch, right?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants